[Workflow Interface] Rename and Refactor WorkspaceExport into NotebookTools #1364
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: refai06 <[email protected]>
Signed-off-by: refai06 <[email protected]>
refai06
requested review from
MasterSkepticista,
kta-intel,
psfoley,
teoparvanov and
rahulga1
as code owners
There was a problem hiding this comment.
Could having an overloaded NotebookTools.export function contribute to a more streamlined user interface? With the introduction of SecureFederatedRuntime (and other runtime environments in the future), users could leverage a single export call (with varying parameters), allowing the system to internally determine the appropriate export flow for each runtime.
Signed-off-by: refai06 <[email protected]>
Signed-off-by: refai06 <[email protected]>
Signed-off-by: refai06 <[email protected]>
Signed-off-by: refai06 <[email protected]>
Signed-off-by: refai06 <[email protected]>
refai06
requested review from
noopurintel,
payalcha,
rajithkrishnegowda,
ishaileshpant and
tanwarsh
as code owners
refai06
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
This PR refactors
WorkspaceExportfunctionality into distinct classes:NotebookToolsandCodeAnalyzer. This change is intended to improve code organization, maintainability, and readability to user.Change Description:
NotebookTools:The main interface for workspace export and management operations.
Handles two export interfaces:
export(): Aggregator-based workflow export.export_federated(): FederatedRuntime-specific export.Responsible for generating configuration and requirements files.
CodeAnalyzer:A dedicated helper class for code analysis and transformation.
Provides utilities for converting notebooks to Python scripts, analysing and extracting key information, including flow details, configurations, runtime details.
Note:
NotebookToolsprovides the user interface (for Aggregator based workflow) and internally utilizes theCodeAnalyzerclass.NotebookToolsreplaces theWorkspaceExportmodule.Deleted:
openfl/experimental/workflow/workspace_export/export.pyFiles Added:
openfl/experimental/workflow/notebooktools/notebook_tools.pyopenfl/experimental/workflow/notebooktools/code_analyzer.pyFiles Modified:
openfl-tutorials/experimental/workflow/1001_Workspace_Creation_from_JupyterNotebook.ipynbopenfl-tutorials/experimental/workflow/Vertical_FL/TwoPartyWorkspaceCreation.ipynbopenfl/experimental/workflow/interface/cli/workspace.pyopenfl/experimental/workflow/runtime/federated_runtime.pyVerification:
Following tutorials are validated to ensure the refactoring is working fine
openfl-tutorials/experimental/workflow/FederatedRuntime/301_MNIST_Watermakingopenfl-tutorials/experimental/workflow/1001_Workspace_Creation_from_JupyterNotebook.ipynbTest Case:
Following test cases are added which validates the NotebookTools
export()andexport_federated()functionalitytests/openfl/experimental/workflow/NotebookTools/tescase_exporttests/openfl/experimental/workflow/NotebookTools/testcase_export_federated